/**
 * Copyright © 2009 sai
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * IRelationLib.java
 * 
 * 2009-1-12 下午09:56:06
 */
package org.lstc.sai.nlp;

/**
 * 一个特定的关系的数据库，设关系为r。
 * 
 * @author sai
 * 2009-1-12 下午09:56:06
 */
public interface IRelationLib {
	/**
	 * 获得库的关系类型。
	 * 
	 * @return 库的关系类型 r 。
	 */
	public RelationShip getRelationType();
	
	/**
	 * 获得该库所有记录的条数，即 ‖*,r,*‖。
	 * 
	 * @return 记数据
	 */
	public int size();
	
	/**
	 * 获得两个词基于所有关系的同现的次数，即 ‖w1,r,w2‖。
	 * 
	 * @param w1 词A
	 * @param w2 词B
	 * @return 词A 和 词B 基于所有关系同现的次数。
	 */
	public int getCountOfTwoWords(String w1, String w2);
	
	/**
	 * 获得与词A相关的记录的条数，即 ‖w1,r,*‖。
	 * 
	 * @param w1 词A
	 * @return 词A在库中出现的次数。
	 */
	public int getCountOfWordA(String w1);
	
	/**
	 * 获得与词B相关的记录的条数，即 ‖*,r,w2‖。
	 * 
	 * @param w2 词B
	 * @return 词B在库中出现的次数。
	 */
	public int getCountOfWordB(String w2);
}
